Get

Function

This API is used to get the AI > Recognition > PlateGroup license plate group.

Request Message

Parameter Description

Table 1

ParameterRangeTypeDescription
MsgIdnullmoot
DefaultValintGet default alarm parameters or actual alarm parameters, 1- default parameters, 0- actual parameters
SimpleInfointGet simple information or complete information. Simple information only includes Group name, Id, DetectType, Policy, Enabled, CanDel, Similarity, and complete information includes all parameters of the group. 1- Get abbreviated information, 0- complete information
GroupsId[1,2,3…x]arrayObtain the configuration information of the corresponding group. If the field is empty or absent, obtain the data of all groups

Sample:

POST /API/AI/PlateGroup/Get HTTP/1.1

{
	"data": {
		"MsgId": "",
		"DefaultVal": 0,
		"SimpleInfo": 1,
"GroupsId": [
            1,
            2,
            3，
			…
        ]
	}
}

Response Message

Parameter Description

Table 2

ParameterRangeTypeDescription
MsgIdnull
Result0，-1，-2，….-23, -24intRequest return results seeTable 3,This field is not required when Modify is used
channelstring arrayList of channel names. This field is not required when Modify is used
Count0-64intNumber of plates
GroupJSON arrayLicense Plate Group Information JSON show as follow Table 4
controlsObjectDatabase interface control, such as tableTable 8As shown (cloud only)

Table 3

Result typeDescription
AORT_SUCCESS = 0succeed
AORT_NO_DB = -1No database
AORT_DB_EXEC_FAILED = -2Database execution failure
AORT_CALC_FEATURE_FAILED = -3Feature extraction failure
AORT_CANCELED = -4canceled
AORT_NO_DISK = -5No hard disk
AORT_DISK_ERROR = -6Hard disk error
AORT_EXIST = -7Already exist
AORT_GROUP_INVALID = -8Group invalid
AORT_NOT_EXIST = -9inexistence
AORT_MORE_FILE_EXIST = -10File already exists
AORT_SEARCH_ERROR = -11Search error
AORT_OVER_MAX_COUNT = -12upper limit exceeded
AORT_UPDATING_FEATURE = -13Updating feature values
AORT_NO_USABLE_IPC = -14There is no IPC vailable for eigenvalue calculation
AORT_INVALID_PARAM = -15invalid parameter
AORT_INVALID_FORMAT = -16malformed
AORT_INVALID_RES = -17resolution error
AORT_INVALID_MEM = -18File too large error
AORT_CREAT_FAILED = -19create failed
AORT_MD5_NOT_MATCH = -20MD5 mismatch
AORT_POS_ERROR = -21wrong location
AORT_SIZE_ERROR = -22size error
AORT_NOT_READY = -23not ready
AORT_INVALID_DB = -24invalid database
AORT_GRP_INVALID_OR_INTERNAL-25
AORT_GRP_FACE_OVER_MAX-26
AORT_NO_PERMISSION-27
AORT_GRP_PLATE_OVER_MAX-28

Table 4 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Id || int |License plate group ID | |Name |" Allow List"
" Block List "
…... |string |License plate group name, the group name can be customized, cannot be the same name | |DetectType |2 |int |Fixed to 2 (DLDT_Plate) | |Policy| 0-2 |int |Policy attribute: 0-Allow List, 1-Block List, 2-Unknown | |Enabled| 0,1 |int |License plate alarm Enable 0: off 1: on | |CanDel |0,1| int |A predefined group cannot be deleted and is identified by the CanDel field. 0 cannot be deleted | |Similarity |0-4| unsigned int| Fault tolerance rate: indicates the maximum number of characters that are allowed to make errors. For example, 0 indicates zero tolerance. All characters must be matched | |PolicyConfigs ||JSON array |Group alarm policy configuration, fixed to 2 elements, only the 0th element is used, the first element is discarded. PolicyConfigs JSON show as followTable 5| |EnableChnAlarm| [255, 255, 255, 255]| array |Control the channels in which the corresponding group is allowed to alarm, according to the bit bit position indicates that the corresponding channel is allowed to alarm | |AlarmOut || Object|Alarm output association Information JSON show as follow Table 6|

Table 5 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |ChnAlarmOut |[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
...
[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255,0,255] ] |array |Each element represents the alarm output associated with a channel, there are 3 main elements, the 0 th represents the local alarm output, the 1/2 represents the front-end alarm output 0/1, and each bit of the child element indicates whether the alarm output of the channel is associated | |ChnBuzzerOpt| [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 …] |array |Each element indicates the buzzer configuration of a channel, 0-disable, 1-10s, 2-20s, 3-40s, 4-60s | |LatchTimeOpt |[0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 …]| array |Each element represents the alarm output duration of a channel, 0-0s, 1-1s, 2-2s, 3-3s, 4-5s, 5-10s, 6-20s, 7-40s, 8-60s | |SaveImg |[255, 255, 255, 255…] |array |Each element represents the configuration of whether a channel saves pictures, and the use of bits in each element indicates whether to save faces and backgrounds | |SendEmail |[0, 0, 0, 0] |array |Used in bits, each bit indicates whether a channel sends mail,0- not to send, 1- to send | |UploadToFtp |[255, 255, 255, 255]| array |Each bit indicates whether a channel uploads FTP | |UploadToCloud |[0, 0, 0, 0]| array |Used in bits, each bit indicates whether a channel is uploading to the Cloud, 0- not uploading, 1- uploading | |ShowThumbnail| [255, 255, 255, 255] |array |Used in bits, each bit represents a channel that is displayed as a thumbnail | |Record| [255, 255, 255, 255] |array |Used in bits, each bit indicates that a channel is recording | |Push |[0, 0, 0, 0]| array |Used by bit, each bit indicates whether a channel sends push, 0- no push, 1- push | |AlarmSchedule| [[255, 255, 255, 255, 255, 255],...],
[[255, 255, 255, 255, 255, 255] ...]|array |Alarm schedule, each bit represents half an hour, a total of 48 bits, set indicates video, and vice versa | voice_prompts_speaker_select||array|播放ip speaker，按位算（bit0是ip speaker 1，bit1对应ip speaker 2）。|

Table 6 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Local|"Local->1"
"Local->2"
"Local->3"
……
The number of local's depends on the capability of the device.| string array |Local alarm linkage.| |Ipc|| JSON array |Front-end alarm linkage. IPC JSON show as follow Table 7|

Table 7 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Channel || int| Front-end alarm output associated channel | |AlarmOutCnt || int| Indicates the number of front-end alarm outputs, front-end support 2 alarm outputs | | alarm_out| | array | The name string of the IO alarm output. The client can use this string to display (cloud only) |

Table 8 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |column| |Object|The database parameter interface JSON is shown in Table Table 9| |showFaceInfoAllMenu| |bool|Determine whether you have configuration permission. If you do not have configuration permission, hide these three menu options together with the board (Move To option)| |addGroupBtn| |bool|Add Schedule button| |isCanModifyGroupName| |bool|Is it possible to rename the button?| |show_tilte_pre| |bool|Title Display|

Table 9 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |delete| |bool|Database delete button| |edit| |bool|Database Edit Button| |enable_Enabled| |bool|Database enable button| |enable_EnableAlarm| |bool|Database IO enable button| |policy| |bool|Database permissions interface| |similarity| |bool|Database Similarity| |alarm| |bool|Database alarm linkage button| |alarm_schedule| |bool|Database Schedule Settings Button| |alarm_channel| |bool|Alarm channel|

Tips:

Response messages and request messages may not contain all the fields in the table above. If no fields are included, the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": {
        "channel": [
            "CH1",
            "CH2",
            "CH3",
			...
        ],
        "Result": 0,
        "Count": 4,
        "Group": [
            {
                "Id": 1,
                "Name": "白名单",
                "Policy": 0,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
            {
                "Id": 2,
                "Name": "黑名单",
                "Policy": 1,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
            {
                "Id": 3,
                "Name": "未知",
                "Policy": 2,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
			...
        ]
    }
}

Example (cloud only)：

HTTP/1.1 200 OK
Content-Type: application/json

{
	"data": {
		"MsgId": null,
		"Result": 0,
		"Count": 5,
		"controls": {
			"column": {
				"delete": true,
				"edit": true,
				"enable_Enabled": true,
				"enable_EnableAlarm": true,
				"policy": true,
				"similarity": true,
				"alarm": true,
				"alarm_schedule": true,
				"alarm_channel": true
			},
			"showFaceInfoAllMenu": true,
			"addGroupBtn": true,
			"isCanModifyGroupName": true,
			"show_tilte_pre": true
		},
		"Group": [
			{
				"Id": 2,
				"Name": "Block List",
				"DetectType": 0,
				"Policy": 0,
				"Enabled": 1,
				"CanDel": 0,
				"Similarity": 70,
				"PolicyConfigs": [
					{
						"ChnAlarmOut": [
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
							...
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ]
						  ],
						  "ChnBuzzerOpt": [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 ],
						  "LatchTimeOpt": [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 ],
						  "SaveImg": [255, 255, 255, 255],
						  "SendEmail": [0, 0, 0, 0],
						  "UploadToFtp": [255, 255, 255, 255],
						  "UploadToCloud": [0, 0, 0, 0],
						  "ShowThumbnail": [255, 255, 255, 255],
						  "Record": [255, 255, 255, 255],
						  "Push": [0, 0, 0, 0],
						  "AlarmSchedule": [
							[
								{
									"enable": true,
									"weekday": [
										"Sunday",
										"Thursday"
									],
									"start_time": 120,
									"end_time": 540
								},
								...
							],
							[
								{
									"enable": true,
									"weekday": [
										"Sunday",
										"Thursday"
									],
									"start_time": 120,
									"end_time": 540
								},
								...
							],
							...
						]
					},
					{
						"ChnAlarmOut": [
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
							...
							[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ]
						  ],
						  "ChnBuzzerOpt": [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 ],
						  "LatchTimeOpt": [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 ],
						  "SaveImg": [255, 255, 255, 255],
						  "SendEmail": [0, 0, 0, 0],
						  "UploadToFtp": [255, 255, 255, 255],
						  "UploadToCloud": [0, 0, 0, 0],
						  "ShowThumbnail": [255, 255, 255, 255],
						  "Record": [255, 255, 255, 255],
						  "Push": [0, 0, 0, 0],
						  "AlarmSchedule": [
							[
								{
									"enable": true,
									"weekday": [
										"Sunday",
										"Thursday"
									],
									"start_time": 120,
									"end_time": 540
								},
								...
							],
							[
								{
									"enable": true,
									"weekday": [
										"Sunday",
										"Thursday"
									],
									"start_time": 120,
									"end_time": 540
								},
								...
							],
							...
						]
					}
				],
				"EnableChnAlarm": [255, 255, 255, 255]，
				"AlarmOut": {
					"Local": ["Local->1"],
					"Ipc": [{
						"Channel": 1,
						"AlarmOutCnt": 1,
						"CH2(172.16.11.134)->1"
					}, {
						"Channel": 4,
						"AlarmOutCnt": 1
						"CH2(172.16.11.135)->1"
					}, {
						"Channel": 5,
						"AlarmOutCnt": 1
						"CH2(172.16.11.136)->1"
					}]
				}
			},
			...

		]
	}
}

Error Code

See Response Messages Body and Common error_code for more information.